[Doc] Upgrade build tooling#2
Merged
peytondmurray merged 1 commit intodocs-build-system-upgradefrom Nov 16, 2023
Merged
Conversation
peytondmurray
force-pushed
the
docs-build-system-upgrade-build-tooling
branch
from
86a6166 to
d2b0a4a
Compare
peytondmurray
changed the title
peytondmurray
changed the title
peytondmurray
changed the title
peytondmurray
force-pushed
the
docs-build-system-upgrade-build-tooling
branch
from
d2b0a4a to
1129b29
Compare
This was referenced Nov 14, 2023
peytondmurray
force-pushed
the
docs-build-system-upgrade-build-tooling
branch
from
1129b29 to
e4aff8b
Compare
This was referenced Nov 14, 2023
Signed-off-by: pdmurray <peynmurray@gmail.com>
peytondmurray
force-pushed
the
docs-build-system-upgrade-build-tooling
branch
from
e4aff8b to
8c1979d
Compare
maxpumperla
reviewed
Nov 15, 2023
| https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx-core-events | ||
| """ | ||
| if pagename == "train/train": | ||
| app.add_css_file("css/ray-train.css") |
maxpumperla
approved these changes
Nov 15, 2023
maxpumperla
left a comment
maxpumperla
left a comment
There was a problem hiding this comment.
This is great, we really needed that clean-up.
Can be done later, but can we move the parse_navbar_config etc. to e.g. custom_directives.py or so? conf.py is the one file most of our devs have to have a look at occasionally, and I don't want to blow it up too much.
Owner
Author
Yep, good idea. I'll make a checklist for this kind of cleanup in the target branch for this PR, and do this before we merge ray-project#41115. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
This PR implements build tooling changes needed for the doc build system upgrade.
-W: Turn warnings into errors during the build-j auto: Enable parallel builds, significantly improving the time it takes to build the docsrequirements-doc.txtsphinx-version-warning- we weren't using it, it's unmaintained, and the JS was throwing errors upon page loadsphinx-tabs, becausepydata-sphinx-themeusessphinx-design, which has a tab widget already. Having two tab widgets is a recipe for conflicting styles; additionally,sphinx-tabshas a bug where thejsassets for tabs are injected on every page even if no tabs are being used on that page; seesphinx-tabsassets are not removed from pages wheretabsaren't being used executablebooks/sphinx-tabs#184sphinx-external-tocas it is incompatible with the latest versions ofsphinx. It's not needed here, and has not seen much development in the past year._toc.ymlis removed as a result of this.pydata-sphinx-theme, which is the theme on whichsphinx-book-themeis based. It's currently actively maintained, and has seen recent releases with big improvements to accessibility. It also comes with a lot of what we want right out of the box, and using it removes a dependency from our docs build system. I think I've talked this decision at length now to multiple people, but if there are still any questions about this choice I'm happy to discuss further.Related issue number
Partially addresses ray-project#37944.
PR 1/x targeting ray-project#41115.
Tests may not pass here because some css and js assets and templates will be committed in a separate PR.
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.